Skip to content

Conversation

@ryanmerolle
Copy link
Contributor

@ryanmerolle ryanmerolle commented Jan 19, 2026

  • Ran ruff on python files
  • Fixed yamllint and end of file new line issues
  • Updated documentation around dev tooling where broken

@ryanmerolle ryanmerolle requested a review from a team as a code owner January 19, 2026 20:56
@ryanmerolle
Copy link
Contributor Author

Outstanding issues (I need feedback):

  • Usage of hyphens to correct spacing issues prevents me from clearing out all j2lint issues as mentioned n Address Template whitespace issues #30. We can merge this with the j2lint issues or correct the lint issues using an approach in Address Template whitespace issues #30.
  • uv run invoke validate is not a defined command, would you like me to define this or remove this from the docs/docs/developer-guide.mdx

### Required software

- **Python 3.11 or 3.12** - The demo requires a recent Python version
- **Python 3.10, 3.11 or 3.12** - The demo requires a recent Python version
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ryanmerolle there was some reason I went with >3.10, but can't remember which part of this bundle cared about that. Did you test this on 3.10?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No I just noticed pyproject.toml mentioned requires-python = ">=3.10,<3.13" so I was updating to match that. I can test if you need, or we can just bump everything to 3.11 and not think twice about this given uv and venv.


# 5. Populate security relationships (optional, required if you loaded security data)
uv run python scripts/populate_security_relationships.py
# 5. Add the demo repository
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not quite sure why you're recommending that the firewall policy relationships don't get loaded. Otherwise the firewall rules aren't all linked. This is a workaround to Infrahub object files not being able to support many-to-many relationships at present.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not recommending that. I noticed there is no file with that name in the repo.

➜  infrahub-bundle-dc git:(repo_tooling) ✗ tree scripts
scripts
├── bootstrap.py
├── create_proposed_change.py
├── create_users_roles.py
└── get_configs.py

1 directory, 4 files
➜  infrahub-bundle-dc git:(repo_tooling) ✗ find . -name "populate_security_relationships.py"
➜  infrahub-bundle-dc git:(repo_tooling) ✗ find . -name "create_proposed_change.py"
./scripts/create_proposed_change.py

### Documentation

For detailed setup instructions, configuration options, and usage guide, see [SERVICE_CATALOG.md](SERVICE_CATALOG.md).
For detailed setup instructions, configuration options, and usage guide, see [docs/docs/service-catalog.mdx](docs/docs/service-catalog.mdx).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the correct path here should be ./service-catalog.mdx as it's a file in the same directory, otherwise it'll look for docs/docs/docs/docs/service-catalog.mdx`

I think the previous one worked because docusaurus strips off .md or .mdx when compiling.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the root level README.md. If you click the link from the README.md from this branch you will see it works and redirects you appropriately,

@petercrocker
Copy link
Contributor

I think the challenge here is your tooling is different to ours, and as we're trying to run consistent tooling across many employees, many repos and many CI pipelines so that it's more maintainable when they're as consistent as possible. It would be good to pull apart the content differences vs. the linting/tooling differences.

@ryanmerolle
Copy link
Contributor Author

I think the challenge here is your tooling is different to ours, and as we're trying to run consistent tooling across many employees, many repos and many CI pipelines so that it's more maintainable when they're as consistent as possible. It would be good to pull apart the content differences vs. the linting/tooling differences.

Always a fair comment.

I think its pretty safe to say the following are non-controversial an use your same tooling:

  • ruff fixes
  • yamllint
  • end of file fixing

I am not aware of any tooling for jinja that would conflict with implementing the j2linter. It makes Jinja2 way more readable. It's developed and used by Arista for that end on the AVD repo. It's slowly made its way into some popular projects associated with Ansible, Openstack, etc.

prek/pre-commit is an optional thing. I am happy to remove it.

Tell me what you like and what you want ripped out and I'm happy to adjust.

@ryanmerolle ryanmerolle reopened this Jan 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants